Design documentation
Contents |
[edit] Introduction
Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent record keeping. A document is a representation of information in a written, drawn or digital form.
Design documentation is a term that is sometimes associated with the development of computer software (as in architecture design documentation) and web design (as in user experience or UX). In Design Documentation: Why You Need It, Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:
- Making documentation usable for the target audience.
- Providing up-to-date documentation.
- Working on design documentation incrementally.
- Testing documentation.
- Avoiding jargon.
- Creating easy access.
- Providing visual samples in the documentation.
Generally, this sort of design documentation should include information about users, implementation details, agreed upon decisions and project deadlines. The creation of design documentation should take place during the early stages of a project in order to clarify expectations and expedite the achievement of goals.
[edit] Building design documentation
These same basic principles can apply to design documentation for building and construction. At the very least, there should be a suitable amount of documentation written to inform staff at an appropriate level of the work that they are expected to complete.
Ideally, this collection of documents and resources should cover all design aspects of a building project, including decisions that have been made during the design process to satisfy business, legal, environmental, social, technical and so on requirements and support the execution of the design.
This can include specifications, drawings, operational information, and other relevant documents (explanatory diagrams, tables and charts, standards, surveys and so on).
The amount and depth of the documentation will depend on the requirements of the design brief, and other documentation such as employers information requirements.
There are a number of articles on Designing Buildings describing particular types of documentation and documents:
- Contract documents.
- Tender documentation.
- Types of drawings.
- Briefing documents.
- Specifications.
- Legislation.
- Regulations.
- Planning permission.
- Certificates.
- Permits.
- Approvals.
- BIM.
- Construction contract certificates, notices and instructions.
For more information see: Design process.
[edit] Related articles on Designing Buildings
- Commissioning documentation.
- Document.
- Handover to client.
- Project brief for design and construction.
- Quality management systems (QMS) - beyond the documentation.
- Record keeping.
- User experience UX.
[edit] External resources
- Nick Babich, Design Documentation: Why You Need It.
Featured articles and news
Quality Planning for Micro and Small to Medium Sized Enterprises
A CIOB Academy Technical Information sheet.
A briefing on fall protection systems for designers
A legal requirement and an ethical must.
CIOB Ireland launches manifesto for 2024 General Election
A vision for a sustainable, high-quality built environment that benefits all members of society.
Local leaders gain new powers to support local high streets
High Street Rental Auctions to be introduced from December.
Infrastructure sector posts second gain for October
With a boost for housebuilder and commercial developer contract awards.
Sustainable construction design teams survey
Shaping the Future of Sustainable Design: Your Voice Matters.
COP29; impacts of construction and updates
Amid criticism, open letters and calls for reform.
The properties of conservation rooflights
Things to consider when choosing the right product.
Adapting to meet changing needs.
London Build: A festival of construction
Co-located with the London Build Fire & Security Expo.
Tasked with locating groups of 10,000 homes with opportunity.
Delivering radical reform in the UK energy market
What are the benefits, barriers and underlying principles.
Information Management Initiative IMI
Building sector-transforming capabilities in emerging technologies.
Recent study of UK households reveals chilling home truths
Poor insulation, EPC knowledge and lack of understanding as to what retrofit might offer.
Embodied Carbon in the Built Environment
Overview, regulations, detail calculations and much more.
Why the construction sector must embrace workplace mental health support
Let’s talk; more importantly now, than ever.
Ensuring the trustworthiness of AI systems
A key growth area, including impacts for construction.